- Title
- Open-source framework for documentation of scientific software written on MATLAB-compatible programming languages
- Creator
- Konnik, Mikhail V.; Welsh, James
- Relation
- Software and Cyberinfrastructure for Astronomy II. Software and Cyberinfrastructure for Astronomy II: Proceedings of SPIE, Vol. 8451 (Amsterdam, Netherlands 01-04 July, 2012)
- Publisher Link
- http://dx.doi.org/10.1117/12.924952
- Publisher
- Society of Photo-Optical Instrumentation Engineers (SPIE)
- Resource Type
- conference paper
- Date
- 2012
- Description
- Numerical simulators for adaptive optics systems have become an essential tool for the research and development of the future advanced astronomical instruments. However, growing software code of the numerical simulator makes it difficult to continue to support the code itself. The problem of adequate documentation of the astronomical software for adaptive optics simulators may complicate the development since the documentation must contain up-to-date schemes and mathematical descriptions implemented in the software code. Although most modern programming environments like MATLAB or Octave have in-built documentation abilities, they are often insufficient for the description of a typical adaptive optics simulator code. This paper describes a general cross-platform framework for the documentation of scientific software using opensource tools such as LATEX, mercurial, Doxygen, and Perl. Using the Perl script that translates M-files MATLAB comments into C-like, one can use Doxygen to generate and update the documentation for the scientific source code. The documentation generated by this framework contains the current code description with mathematical formulas, images, and bibliographical references. A detailed description of the framework components is presented as well as the guidelines for the framework deployment. Examples of the code documentation for the scripts and functions of a MATLAB-based adaptive optics simulator are provided.
- Subject
- software documentation; doxygen; LATEX; numerical simulators
- Identifier
- http://hdl.handle.net/1959.13/1055686
- Identifier
- uon:15924
- Identifier
- ISBN:9780819491527
- Rights
- Copyright 2012 Society of Photo-Optical Instrumentation Engineers. One print or electronic copy may be made for personal use only. Systematic reproduction and distribution, duplication of any material in this paper for a fee or for commercial purposes, or modification of the content of the paper are prohibited
- Language
- eng
- Full Text
- Reviewed
- Hits: 1249
- Visitors: 1525
- Downloads: 309
| Thumbnail | File | Description | Size | Format | |||
|---|---|---|---|---|---|---|---|
| View Details Download | ATTACHMENT01 | Publisher version (open access) | 1 MB | Adobe Acrobat PDF | View Details Download |